Inside Macintosh: QuickDraw GX Objects /

Chapter 5 - Ink Objects / Ink Objects Reference

Functions / Manipulating Ink Object Properties

GXSetShapeInkAttributes

You can use the GXSetShapeInkAttributes function to set or clear attributes of the ink associated with a shape.

void GXSetShapeInkAttributes(gxShape target, 
                           gxInkAttribute attributes);

target

A reference to the shape whose ink object you want to change the attributes of.

attributes

The new ink attributes to be assigned.

DESCRIPTION

The GXSetShapeInkAttributes function assigns the ink attributes specified by the attributes parameter to the ink object associated with the shape referenced in the target parameter. It is almost equivalent to the following call:

GXSetInkAttributes(GXGetShapeInk(target),attributes);

The only difference is that, if the source shape's ink object is shared with other shapes, GXSetShapeInkAttributes creates a new copy of the ink object, attaches it to the source shape, and changes the attributes of the copy. That way, calling this function does not produce side effects on other shapes.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
shape_is_nil
parameter_out_of_range	(debugging version)
Notices (debugging version)
attributes_already_set

SEE ALSO

To examine the attributes of the ink object associated with a shape, use the GXGetShapeInkAttributes function, described in the previous section.

To set the attributes of an ink object itself, use the GXSetInkAttributes function, described on page 5-62.

Ink attributes are described in the section "Ink Attributes" beginning on page 5-9. The GXSetInkAttributes function is described on page 5-62.

The GXGetShapeInk function is described in the chapter "Shape Objects" in this book.